Oracle TimesTen In-Memory Database C開発者およびリファレンス・ガイド

ttUtilFreeEnv

TimesTenユーティリティ・ライブラリ環境ハンドルに関連付けられているメモリーを解放します。

アプリケーションでは、他のすべてのTimesTenユーティリティ・ライブラリ関数より前に、ttUtilAllocEnvをコールする必要があります。また、TimesTenユーティリティ・ライブラリ・インタフェースを使用して処理を行う場合は、 ttUtilFreeEnvをコールする必要があります。

ttUtilFreeEnv (ttUtilHandle handle, char *errBuff, unsigned int buffLen, unsigned int *errLen);

ttUtilFreeEnv には、次のパラメータがあります。


パラメータ	型	説明
handle	ttUtilHandle	ttUtilAllocEnvを使用して割り当てられるTimesTenユーティリティ・ライブラリ環境ハンドルを指定します。
errBuff	char *	エラー・メッセージがある場合に返される、ユーザーが割り当てるバッファ。返されるエラー・メッセージはヌル終端文字列です。エラー・メッセージは、その長さがbuffLen-1を超えると、buffLen-1に切り捨てられます。このパラメータがNULLの場合、buffLenは無視され、TimesTenはコール元のアプリケーションにエラー・メッセージを返しません。
buffLen	unsigned int	バッファerrBuffのサイズを指定します。このパラメータが0（ゼロ）の場合、TimesTenはコール元のアプリケーションにエラー・メッセージを返しません。
errLen	unsigned int *	エラー・メッセージの実際の長さが返される、符号なし整数へのポインタ。NULLの場合、このパラメータは無視されます。

ttUtilFreeEnvは、次のコード（ttutillib.hで定義されています）を返します。


コード	説明
TTUTIL_SUCCESS	成功時に返します。
TTUTIL_INVALID_HANDLE	無効なユーティリティ・ライブラリ・ハンドルが指定されている場合に返します。

これ以外の場合、TimesTen固有のエラー・メッセージ（tt_errCode.hに定義されています）および対応するエラー・メッセージが、コール元によって提供されるバッファに返されます。

utilHandleというTimesTenユーティリティ・ライブラリ環境ハンドルを解放するには、次のように入力します。

char errBuff [256];

int rc;

ttUtilHandle utilHandle;

rc = ttUtilFreeEnv (utilHandle, errBuff, sizeof(errBuff), NULL);